Deprecate the params field of _obtain_token #860
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Avery-Dunn
changed the title
|
In Python, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecates the ability to send arbitrary query parameters to a token request according to KR 3310905, similar to what was done in other MSALs:
AzureAD/microsoft-authentication-library-for-dotnet#5536
AzureAD/microsoft-authentication-library-for-java#1001
This behavior was intended for niche scenarios which the library did not explicitly cover, and not really meant for production. It can affect the contents and validity of tokens but were not used in our caching scheme which led to bad caching behavior: if the extra query parameters changed between requests we could return tokens that were not valid for the latest set of parameters.
MSAL Python did not have an explicit
WithExtraQueryParametersAPI like other MSALs, however the internalBaseClient._obtain_tokenandClient._obtain_tokenfunctions had aparamsargument which set the query parameters just like other MSALs. A customer could define these params by setting them in thekwargsargument of some public APIs.This PR removes the explicit
paramsargument from those functions. For backwards compatibility we still check thekwargsargument forparams, and if it is used a deprecation warning inBaseClient._obtain_tokenwill inform the customer.